home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 2 / MacMania 2.toast / Demo's / Internet MacSoftware / ircle 2.0f2.sit / ircle 2.0f2.rsrc / TEXT_128_ircle Help.txt < prev    next >
Encoding:
Text File  |  1995-03-29  |  13.5 KB  |  209 lines

  1. Help for ircle 2.0
  2.  
  3. This is ircle, a Macintosh-based, windowed user interface to the Internet Relay Chat (IRC) network. 
  4.  
  5. This window contains:
  6.  
  7. 0. Brief Overview on IRC
  8. 1. ircle Basics and Windows
  9. 2. IRC Commands and ircle Menus
  10. 3. Hints & Advice
  11. 4. General notes, Copyright Notice
  12.  
  13. 0. Brief Overview on IRC
  14.  
  15. (If you know IRC, skip this section)
  16. IRC is a multi-user online chatting system. It allows users to talk to other users all around the world via the Internet. This is done by connecting a client program (such as this one) to a server. You need a connection to any network connected to the Internet and running TCP/IP, and the MacTCP network driver. You have to select your preferred server (usually the nearest), using the popup menu in the Preferences dialog. The port number used by IRC servers is usually 6667.
  17.  
  18. On IRC, users are identified by nicknames of their own choice. Nicknames may be at most 9 characters long.  The nickname is set via preferences or the NICK command (see below). If you choose a nickname already in use, you have to set a different nick. Some users have registered their nicknames with the NickServ database. If you get a message from NickServ that your nick is in use, please choose another.
  19.  
  20. Communication on IRC is done via Channels and Private Messages. Channels have names starting with # (public channels) and & (local) and usually up to 12 characters long. You can see a list of the channels currently in use via the /LIST command. As soon as you join a channel with the /JOIN command, everything you type is sent to that channel and seen by all other users on that channel. You will see what the others type, respectively.
  21.  
  22. 1. ircle Basics and Windows
  23.  
  24. ircle has a user interface similar to the traditional text-oriented IRC clients. If you know IRC, you will find it familiar. At the bottom of the screen is the input line in an own small floating window which also carries a line of status information. Everything you type will appear in the input line. When you press Return, the line gets sent to the current channel or, if it contains a command, that command is processed. A line is considered command if it starts with a '/' (slash). You can change this character with the /CMDCHAR command. See Section 2 on commands.
  25.  
  26. You connect to the server via Open conection in the File menu. When the connection to the server is established, the main message window will appear. This window has your nickname in the title bar. 
  27. As soon as you join a channel, a channel window will appear with the channel name and topic as its title. All communication done in that channel will appear in that window. If you close this window, you leave the channel.
  28.  
  29. Querying a user (see below) will open a user window. All private messages from and to that user will appear in this window.
  30. You can switch between windows using the mouse or ‚åò-, (comma) key. The destination of text that you type is always determined by the frontmost window, i.e. the text goes to the channel or user whose name is the frontmost window's title.
  31. The number of windows open at a time is limited only by your computer's memory and your capability of listening at many sources at a time :-)
  32. All messages not coming from or related to a channel or queried user will appear in the main message window. That can include long lists from certain commands. You can skip these by pressing ‚åò-. (dot).
  33. You can arrange the channel windows using ‚åò-T (Tile Windows, all channel window's size are adjusted so that they are completely visible), or the Stack Windows (all windows are put on top of each other, showing only the title bars).
  34.  
  35. 2. IRC Commands and ircle Menus
  36.  
  37. Traditionally, IRC is controlled by typing commands. A line starting with a slash (/) is considered a command. ircle has implemented this behaviour instead of a mouse-driven environment for simplicity and user-interface compatibility to other IRC clients.  The topic of a channel (shown in the title bar) can be changed by double clicking in it, though. Certain frequently used commands can be reached via menus. These, however, do just paste the commands into the input line and thus are shortcuts for typing the commands.
  38.  
  39. The File menu has items for opening a connection, closing the topmost window (this will leave a channel), setting Preferences, opening/closing a logfile and the Quit command.
  40. The Edit menu has the Copy and Paste items. Text in a window can be selected and copied, then pasted into the input line.
  41. The Commands menus contain selected IRC commands. They get just pasted into the input line and are shortcut for convenience.
  42. The Shortcuts menu provides a means for user-defined shortcuts. They can be defined in a dialog box and called via ‚åò-0 through 9. Note that new settings work only after closing the definitions dialog.
  43. The Font menu lets you set your preferred font and size. This will affect the currently active window and all new windows opened afterwards. It also gets stored in the Set file.
  44. The Windows menu contains the titles of the active windows for fast selection.
  45.  
  46. Preferences settings
  47.  
  48. Preferences settings are stored in the 'ircle preferences' file inside your Preferences folder in the System Folder.
  49.  
  50. The settings in the General Preferences dialog are:
  51.  
  52. Server: The server you want to connect to. This has to be a numeric IP address or a full host.domain name.
  53. Port: Usually 6667, when in doubt check with your server administrator.
  54. Nickname: The nickname you want to start with.
  55. Mail address: You should specify your login name or mail address on a fully qualified (with domain) machine.
  56. Real name: Your real name (or whatever evil thing you want to look like your real name)
  57. Notifications: when messages appear in an inactive window, or in any window while ircle is running in the background, you will get alerted by a sound and/or blinking menu bar item, as you can select by checking these boxes.
  58. Indentation: causes channel text to be indented for clearer reading.
  59. Auto DCC: enables the automatic opening of a DCC CHAT window, or automatic DCC receiving of files.
  60.  
  61. The settings in the Color Preferences dialog are:
  62.  
  63. Colors: sets various message and window colors. Click on a color box to change it.
  64.  
  65. Sounds: enables sound to be played when people sign on and off, are being kicked, when MODE changes appear and when NOTIFY find a person coming on or offline.
  66.  
  67. Description of IRC Commands
  68.  
  69. The following commands are currently available: (x) = untested. 
  70.  
  71. /admin nick 
  72. /admin server           shows administrative info
  73. /away message           marks you as being away (no message = not away)
  74. /bye message            displays message and quits IRC
  75. /broadcast message      sends a message to all of your windows
  76. /channel channel        join a channel
  77. /cmdchar c              changes the command-prefix (default /) to the given character
  78. /cping nick             shows response time for nick
  79. /ctcp target command    issues a CTCP command. Do /ctcp target clientinfo for more info.
  80. /date                   display date and time
  81. /dcc command nick       issues a DCC command (explained below)
  82. /exit message           = /bye
  83. /ignore pattern         ignore messages from nick!user@host (may contain wildcards)
  84.         +pattern        ignore and give the ignored a notice
  85.         -pattern        removes a pattern from the ignore list
  86. /info                   gives info about server
  87. /invite nick channel    invites nick to channel
  88. /join                   joins channel last invited to
  89. /join channel           = /channel
  90. /kick channel nick      kicks nick from channel
  91. /leave channel          leave a channel
  92. /links                  show server connections
  93. /list                   list channels
  94.       -min n            list only channels with minimum of n users
  95.       -max n              list only channels with maximum of n users
  96.       -public           list only public channels
  97.       -private          list only private channels
  98.       -local            list only local channels
  99.       -global           list only global channels
  100.       -topic            list only channels with topic set
  101. /lusers                 display statistics
  102. /map                    displays a map of all server connections
  103. /me action              sends an action description
  104. /mode channel parm      set channel mode:
  105.         +p              private channel
  106.         +s              secret channel
  107.         +i              invite-only channel
  108.         +m              moderated channel
  109.         +n              no messages from outside channel
  110.         +t              only channel operator may set topic
  111.         +l ##           channel may hold at most ## users
  112.         +v nick         let nick speak on moderated channel
  113.         +b nick         ban nick
  114.         +k key          set channel password
  115.         +o nick         nick becomes channel operator
  116.         -x              removes flag x, where x is one of the above
  117. /mode nick parm         set user mode:
  118.            +i           invisible user
  119.            +s           receive server notices
  120.            +w           receive wallops
  121. /motd [server]          show message-of-the-day [of another irc server]
  122. /msg nick message       sends nick a private message
  123. /names channel          list users on channel
  124. /nick newnick           change your nickname
  125. /note                   unknown
  126. /notice                 (almost) like /msg
  127. /notify                 show notify list
  128. /notify nick            adds nick to notification list (show each signon/off)
  129.         -nick           removes nick from notification list
  130. /part channel           = /leave
  131. /query nick             open window for private messages to nick
  132. /quit message           = /bye
  133. /server hostname [port] switch to a different server
  134. /silence                show ignored users list
  135. /silence mask           ignores users with selected mask
  136. /signoff message        = /bye
  137. /stats                  show statistical info:
  138.        b                shows ban list
  139.        c                shows list of connections
  140.        k                ?
  141.        l                ?
  142.        o                shows list of operators
  143.        p                ?
  144.                    s                ?
  145.        t                ?
  146.        u                shows server uptime
  147.        y                ?
  148. /summon user@host       invites user@host to IRC (host must be running a server)
  149. /time                   = /date
  150. /topic channel text     set a channel topic (double clicking in the title bar of a channel lets you achieve the same)
  151. /trace [user]           shows which servers are being used to connect to user
  152. /type                   type a text file to the current channel
  153. /users                  (x)
  154. /version                show server version
  155. /wallops message        message to all operators (deprecated)
  156. /who channel            list people on channel
  157. /whois                  give information about nick that last joined the channel or sent private message
  158. /whois nick             give information about nick
  159. /whowas nick            give information about nick no longer online
  160.  
  161.  
  162. IRC Operator commands:
  163.  
  164. /connect                * connect two servers
  165. /die                    * shut down a server
  166. /hash                   * reconfigure a server
  167. /host                   (x)
  168. /kill nick              * kicks nick out of IRC
  169. /oper                   * become operator
  170. /rehash                 * reconfigure a server
  171. /restart                * restart a server
  172. /squit                  * eemove a link between servers
  173. /uping                  * unknown
  174.  
  175. Valid commands for /dcc are:
  176.  
  177. chat  - requests CHAT connection for nick or answers such a request.
  178. send  - send a file.
  179. tsend - send a text file.
  180. get   - receive a file (to be answered to a SEND request).
  181. tget  - receive a text file.
  182. list  - list all DCC connections.
  183.  
  184. 3. Hints & Advice
  185.  
  186. More information on IRC commands can be found in the 'ircle Users manual' and 'IRC Advice' files and probably in the help files for the IRCII client (but note that IRCII has a number of commands for programmability that ircle has not).
  187. When selecting a non-proportional font keep in mind that IRC was originally designed for text terminals and some commands and messages assume a fixed-size screen. That may make output look strange in some situations.
  188.  
  189. This client uses the ISO Latin-1 8-bit character set and converts Macintosh special characters to this code. Some characters can not be converted and will be mapped to nonsensical √∫rs. This also holds for DCC tsend/tget which are text-mode versions of send/get. The conversion table are those also used by Peter Lewis' FTPd.
  190. New users should check the file 'IRC Advice'.
  191.  
  192. 4. General notes, Copyright Notice
  193.  
  194. This program was written by Olaf Titz (s_titz@ira.uka.de), July 1992-July 1993. You may use, copy and distribute it under the terms and conditions of the GNU General Public License, see the file COPYING that should have accompanied this program. Be sure to include the file COPYING when distributing this program.
  195.  
  196. Some parts of this program written by Peter N. Lewis, (¬©) 1992.
  197. Written and compiled using THINK Pascal 2.0.1, thus Portions Copyright (¬©) 1988 Symantec Corp.
  198.  
  199. This program was modified by Onno R. Tijdgat (tijdgat@knoware.nl), September 1994-January 1995 using Think Pascal 4.0.2.
  200.  
  201. Copyright (¬©) 1994-95 Olaf Titz/Onno Tijdgat
  202.  
  203. THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 
  204.  
  205. System requirements: any Mac with System version 7.0 and the MacTCP driver.
  206.  
  207. This client is to fit version 2.7, 2.8 and Undernet servers. All commands and features obsoleted by 2.7 are taken out (as should be all obsolete servers by now). This client is fully compatible with the RFC1459 (IRC) & RFC 1430 (Ident service) documents.
  208.  
  209. Have fun!